Fix GtkIconInfo docs
authorAlexander Larsson <alexl@redhat.com>
Fri, 15 Feb 2013 10:07:51 +0000 (11:07 +0100)
committerAlexander Larsson <alexl@redhat.com>
Fri, 15 Feb 2013 10:07:51 +0000 (11:07 +0100)
gtk_icon_info_copy and gtk_icon_info_free are deprecated for
the corresponding GObject methods.

We set correct transfer markup for the GtkIconInfo returning methods
to fix the introspection of them.

gtk_icon_info_load_symbolic_for_context_async had the wrong method
name in its documentation block.

gtk/gtkicontheme.c
gtk/gtkicontheme.h

index e2c9eaa340257313aac109129e5e854d4175581c..a399ac543f7329670577989a0b3082465555937e 100644 (file)
@@ -1778,9 +1778,8 @@ choose_icon (GtkIconTheme       *icon_theme,
  * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
  * combines these two steps if all you need is the pixbuf.)
  * 
- * Return value: a #GtkIconInfo structure containing information
- * about the icon, or %NULL if the icon wasn't found. Free with
- * gtk_icon_info_free()
+ * Return value: (transfer full): a #GtkIconInfo object containing information
+ * about the icon, or %NULL if the icon wasn't found.
  *
  * Since: 2.4
  */
@@ -1856,9 +1855,8 @@ gtk_icon_theme_lookup_icon (GtkIconTheme       *icon_theme,
  * tries them all in the given order before falling back to 
  * inherited icon themes.
  * 
- * Return value: a #GtkIconInfo structure containing information
- * about the icon, or %NULL if the icon wasn't found. Free with
- * gtk_icon_info_free()
+ * Return value: (transfer full): a #GtkIconInfo object containing information
+ * about the icon, or %NULL if the icon wasn't found.
  *
  * Since: 2.12
  */
@@ -3074,6 +3072,8 @@ icon_info_new_builtin (BuiltinIcon *icon)
  * Return value: the new GtkIconInfo
  *
  * Since: 2.4
+ *
+ * Deprecated: 3.8: Use g_object_ref()
  **/
 GtkIconInfo *
 gtk_icon_info_copy (GtkIconInfo *icon_info)
@@ -3091,6 +3091,8 @@ gtk_icon_info_copy (GtkIconInfo *icon_info)
  * Free a #GtkIconInfo and associated information
  *
  * Since: 2.4
+ *
+ * Deprecated: 3.8: Use g_object_unref()
  **/
 void
 gtk_icon_info_free (GtkIconInfo *icon_info)
@@ -4290,7 +4292,7 @@ gtk_icon_info_load_symbolic_finish (GtkIconInfo   *icon_info,
 }
 
 /**
- * gtk_icon_info_load_symbolic_async:
+ * gtk_icon_info_load_symbolic_for_context_async:
  * @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
  * @context: a #GtkStyleContext
  * @cancellable: (allow-none): optional #GCancellable object,
@@ -4830,7 +4832,7 @@ _gtk_icon_theme_check_reload (GdkDisplay *display)
  * The icon can then be rendered into a pixbuf using
  * gtk_icon_info_load_icon().
  *
- * Return value: a #GtkIconInfo structure containing 
+ * Return value: (transfer full): a #GtkIconInfo structure containing 
  *     information about the icon, or %NULL if the icon 
  *     wasn't found. Free with gtk_icon_info_free()
  *
@@ -4949,7 +4951,7 @@ gtk_icon_theme_lookup_by_gicon (GtkIconTheme       *icon_theme,
  *
  * Creates a #GtkIconInfo for a #GdkPixbuf.
  *
- * Returns: a #GtkIconInfo
+ * Return value: (transfer full): a #GtkIconInfo
  *
  * Since: 2.14
  */
index 4b3ba79867a2056da49ce8a4c6484a8f9346f43a..0b4ee405f607073146ba022443481279e3e4baeb 100644 (file)
@@ -192,7 +192,9 @@ void          gtk_icon_theme_add_builtin_icon      (const gchar *icon_name,
                                                    GdkPixbuf   *pixbuf);
 
 GType                 gtk_icon_info_get_type           (void) G_GNUC_CONST;
+GDK_DEPRECATED_IN_3_8_FOR(g_object_ref)
 GtkIconInfo *         gtk_icon_info_copy               (GtkIconInfo  *icon_info);
+GDK_DEPRECATED_IN_3_8_FOR(g_object_unref)
 void                  gtk_icon_info_free               (GtkIconInfo  *icon_info);
 
 GtkIconInfo *         gtk_icon_info_new_for_pixbuf     (GtkIconTheme  *icon_theme,